docs: trim adrs to decision plus status - #599
Merged
Merged
Conversation
Cut the narrative, considered-option essays, and version-scheduling prose from the eleven ADRs down to context, decision, and load-bearing consequences per the #598 house standard. Update stale vocabulary to the shipped shape: nexum-runtime/nexum-cli crate names, nexum-sdk and nexum-sdk-test, the composable-cow crate path, and the current nullislabs/cow-rs patch channel. Mark 0005 and 0006 superseded by the videre venue-adapter architecture, note 0009's error envelope superseded by 0011, and make 0013's status honest: the Verdict seam has shipped but LegacyRevertAdapter is the live poll path until the fork deploys. Part of #598.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Trims the eleven ADRs under
docs/adr/to context, decision, and load-bearing consequences, cutting the narrative, considered-option essays, and version-scheduling prose (552 lines to 266).Drift fixed against the code: crate names (
nexum-runtime/nexum-cli,nexum-sdk,nexum-sdk-test), thecomposable-cowcrate path (formerlyshepherd-sdk/src/cow/composable.rs), and the currentnullislabs/cow-rspatch channel. Status lines made honest: 0001-0004, 0007, 0011 set to accepted (shipped and live); 0005 and 0006 marked superseded by the videre venue-adapter architecture; 0009 flagged superseded-in-part by 0011 for the error envelope; 0008 kept deferred with the 0.3 scheduling dropped.Why
Part of the #598 cruft-sweep: ADRs record the decision and its status, not the journey to it.
Testing
Documentation-only; no build. Confirmed no em dashes, Oxford -ize spelling, and that no doc links to a renamed or deleted ADR (none were renamed or deleted).
AI Assistance
Documentation-only sweep; verified every retained claim against the runtime code and confirmed no em dashes and no dangling links.
Deviations flagged
docs/adr/0013-composable-cow-structured-poll.md: the ADR's headline guarantee is a structured non-reverting poll, but that wire is not the shipped behaviour.crates/composable-cow/src/poll.rsandrun.rsland theVerdictseam, yetLegacyRevertAdapter(crates/composable-cow/src/poll.rs) mapping the deployed 1.x reverting contract is the live poll path because the fork is deployed on no target chain. The doc now states this rather than asserting the structured wire is live; the wire-swap remains gated on the fork deploying.Part of #598.